Resource {id} | Mars OS REST APIs

Resource /webmapi/lifs/{id}Expand | Collapse

APIs for network interfaces

Deprecated since 1.0.1. See net/interfaces/fc instead.

GET /webmapi/lifs/{id}

Deprecated since 1.0.1. Get a specified LIF instance

Description

Get a specified LIF instance

HTTP Example

GET /webmapi/lifs/{id}

Path Parameters:

idThe ID or name of the instance (required=true).

Output

Reports successful result in ResponseContentType<LifInfoType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
LIF_SHOW_LIF_NOT_FOUND	11003	Interface not found.

Produces

application/json

Since

1.0

PUT /webmapi/lifs/{id}/action/offline

Deprecated since 1.0.1. Offline an online SAN interface

Description

Offline an online SAN interface

HTTP Example

PUT /webmapi/lifs/{id}/action/offline

Path Parameters:

idThe ID or name of the instance (required=true).

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
LIF_OFFLINE_LIF_NOT_FOUND	11001	Interface not found.
LIF_OFFLINE_LIF_NOT_ONLINE	11002	Offline failed because the interface is not currently online.
LIF_OFFLINE_DISCARDED	11013	Internal error occurred and the operation was discarded. This is usually a transient error.
LIF_OFFLINE_SERVICE_STOPPED	11014	Interface state cannot be changed while the FCP service is stopped.

Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/lifs/{id}/action/online

Deprecated since 1.0.1. Online an offline SAN interface

Description

Online an offline SAN interface

HTTP Example

PUT /webmapi/lifs/{id}/action/online

Path Parameters:

idThe ID or name of the instance (required=true).

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
LIF_ONLINE_LIF_NOT_FOUND	11004	Interface not found.
LIF_ONLINE_LIF_NOT_OFFLINE	11005	Online failed because the interface is not currently offline.
LIF_ONLINE_DISCARDED	11015	Internal error occurred and the operation was discarded. This is usually a transient error.
LIF_ONLINE_SERVICE_STOPPED	11016	Interface state can't be changed while the FCP service is stopped.

Produces

application/json

Consumes

application/json

Since

1.0

GET /webmapi/lifs/{id}/initiators

Deprecated since 1.0.1. See fcp instead.Display a list of initiators for a given instance

Description

Display a list of initiators for a given instance

HTTP Example

GET /webmapi/lifs/{id}/initiators

Path Parameters:

idThe ID or name of the instance (required=true).

Output

Reports successful result in ResponseContentType<ContainerType<LoggedInInitiatorInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
LIF_INITIATOR_SHOW_LIF_NOT_FOUND	11010	Interface not found.
LIF_INITIATOR_SHOW_INTERNAL_ERROR	11011	Unable to fetch interfaces information internally.
LIF_INITIATOR_SHOW_IGROUP_NOT_FOUND	11012	Initiator group not found.

Produces

application/json

Since

1.0